API Documentation
ImageView.h
1 // ImageView.h
3 //
5 
6 namespace nkImages
7 {
13  class ImageView final : public ImageBase
14  {
15  public :
16 
20  ImageView () = delete ;
26  ImageView (const Image& image) ;
45  ImageView (const nkMemory::BufferView<unsigned char> dataView, unsigned int width, unsigned int height, unsigned int depth, PIXEL_FORMAT format, unsigned int pixelOrBlockByteSize = 0, unsigned int rowByteSize = 0, unsigned int sliceByteSize = 0) ;
60  ImageView (const nkMemory::BufferView<unsigned char> dataView, unsigned int width, unsigned int height, unsigned int depth, unsigned int arraySize, unsigned int mips, PIXEL_FORMAT format, unsigned int pixelOrBlockByteSize = 0) ;
67  ImageView (const ImageView& other) ;
74  ImageView (const ImageView& other, unsigned int slice) ;
82  ImageView (const ImageView& other, unsigned int slice, unsigned int mip) ;
88  ImageView (ImageView&& other) ;
93 
94  // Data access
98  virtual unsigned char* getDataPtr () const override ;
102  virtual unsigned long long getDataByteSize () const override ;
103 
104  // Operators
110  ImageView& operator= (const ImageView& other) ;
117  } ;
118 }
nkImages::ImageView::getDataPtr
virtual unsigned char * getDataPtr() const override
nkImages::ImageView::ImageView
ImageView(ImageView &&other)
nkMemory::BufferView
A view over data.
Definition: BufferView.h:18
nkImages::ImageView::ImageView
ImageView(const ImageView &other)
nkImages::ImageView
Holds all information required for an image, with no ownership over the data.
Definition: ImageView.h:14
nkImages::ImageView::ImageView
ImageView()=delete
nkImages::ImageView::ImageView
ImageView(const nkMemory::BufferView< unsigned char > dataView, unsigned int width, unsigned int height, unsigned int depth, unsigned int arraySize, unsigned int mips, PIXEL_FORMAT format, unsigned int pixelOrBlockByteSize=0)
nkImages::ImageBase
Base for all image data classes.
Definition: ImageBase.h:19
nkImages
Encompasses all API of component NilkinsImages.
Definition: BmpEncoder.h:7
nkImages::ImageView::ImageView
ImageView(const Image &image)
nkImages::ImageView::~ImageView
~ImageView()
nkImages::PIXEL_FORMAT
PIXEL_FORMAT
Lists formats for pixels.
Definition: PixelFormat.h:16
nkImages::ImageView::getDataByteSize
virtual unsigned long long getDataByteSize() const override
nkImages::ImageView::ImageView
ImageView(const ImageView &other, unsigned int slice, unsigned int mip)
nkImages::ImageView::operator=
ImageView & operator=(const ImageView &other)
nkImages::ImageView::ImageView
ImageView(const nkMemory::BufferView< unsigned char > dataView, unsigned int width, unsigned int height, unsigned int depth, PIXEL_FORMAT format, unsigned int pixelOrBlockByteSize=0, unsigned int rowByteSize=0, unsigned int sliceByteSize=0)
nkImages::ImageView::ImageView
ImageView(const nkMemory::BufferView< unsigned char > &dataView)
nkImages::Image
Holds all information required for an image, with ownership over the data.
Definition: Image.h:14
nkImages::ImageView::ImageView
ImageView(const ImageView &other, unsigned int slice)